Sitemap Generation

Reverb 2.0 generates XML sitemaps following the Sitemaps Protocol. Sitemaps help search engines discover and index all pages in your documentation.

Sitemap Structure

The sitemap generation creates a hierarchical structure:

sitemap.xml

The root sitemap index file that references all group-level sitemaps. Located in the output root directory.

sitemap-pages.xml

Generated for each document group and placed in the corresponding group folder. Contains URLs for all pages within that group.

Sitemap XML Format

The generated sitemap.xml follows the sitemap index format:

<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <sitemap>
    <loc>https://docs.example.com/help/group1/sitemap-pages.xml</loc>
  </sitemap>
  <sitemap>
    <loc>https://docs.example.com/help/group2/sitemap-pages.xml</loc>
  </sitemap>
</sitemapindex>

Each sitemap-pages.xml contains individual page entries:

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://docs.example.com/help/group1/page1.html</loc>
    <lastmod>2025-01-15</lastmod>
  </url>
</urlset>

Note: If the Sitemap Base URL setting is empty, the sitemap will generate with an empty urlset element and a warning will appear in the build log. Always configure the base URL before deploying to production.